bitkeeper revision 1.961 (40cd813a7QpE6VQrh3JjepYkNzoVRw)

typo fix plus some comments

diff --git a/BitKeeper/etc/ignore b/BitKeeper/etc/ignore
index 57e5a0da4bd471d248c9907d4dd9d3b0c5a4992a..8068d4128126d524afc1e0438e31d3fe455b348f 100644 (file)
--- a/BitKeeper/etc/ignore
+++ b/BitKeeper/etc/ignore
@@ -30,3 +30,4 @@ xen/tools/figlet/figlet
 xen/xen
 xen/xen.*
 xen/xen-syms
+install

diff --git a/Makefile b/Makefile
index 97b07673f36ccc1a97964cb58fc6deff09323923..cb19914601846c95d1450e42e6577d9b9afd4161 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -4,15 +4,18 @@
 
 INSTALL_DIR ?= $(shell pwd)/install
 
+# a not partcularly useful but safe default target
 all: make-symlinks
        $(MAKE) -C xen
        $(MAKE) -C tools
 
+# install everything into the standard system directories
 install: all
        $(MAKE) -C xen install
        $(MAKE) -C tools install
        $(shell cp -a install/boot/*$(LINUX_VER)* /boot/)
 
+# install xen and tools into the install directory
 dist: all
        $(MAKE) prefix=$(INSTALL_DIR) dist=yes -C xen install
        $(MAKE) prefix=$(INSTALL_DIR) dist=yes -C tools install
@@ -22,6 +25,7 @@ LINUX_CONFIG_DIR ?= $(INSTALL_DIR)/boot
 LINUX_SRC_PATH   ?= .:..
 LINUX_SRC_X ?= $(firstword $(foreach dir,$(subst :, ,$(LINUX_SRC_PATH)),$(wildcard $(dir)/linux-$(LINUX_VER).tar.gz)))
 
+# search for a pristine kernel tar ball, or try downloading one
 pristine-linux-src: 
 ifneq ($(LINUX_SRC),)
        @[ -r "$(LINUX_SRC)" ] || (echo "Can not find linux src at $(LINUX_SRC)" && false)
@@ -34,30 +38,36 @@ LINUX_SRC_X = ./linux-$(LINUX_VER).tar.gz
 endif
 endif
 
+# make a linux-xen build tree from a pristine kernel plus sparse tree
 linux-$(LINUX_VER)-xen: pristine-linux-src
        $(RM) -rf linux-$(LINUX_VER)-xen
        tar -x -z -f $(LINUX_SRC_X)
        mv linux-$(LINUX_VER) linux-$(LINUX_VER)-xen
        ( cd linux-$(LINUX_VER)-xen-sparse ; ./mkbuildtree ../linux-$(LINUX_VER)-xen )
 
+# config linux-xen from a specified defaults file
 linux_%_config: 
        $(MAKE) -C linux-$(LINUX_VER)-xen ARCH=xen mrproper
        cp $(LINUX_CONFIG_DIR)/config-$(LINUX_VER)-$(subst _config,,$(subst linux_,,$(@))) .config || $(MAKE) -C linux-$(LINUX_VER)-xen ARCH=xen $(subst linux_,,$(@))
        $(MAKE) -C linux-$(LINUX_VER)-xen ARCH=xen oldconfig
        $(MAKE) -C linux-$(LINUX_VER)-xen ARCH=xen dep
 
-linux: 
-       $(MAKE) -C linux-$(LINUX_VER)-xen ARCH=xen INSTALL_PATH=$(INSTALL_DIR) install  
-
+# build and install to a specified install name
 linux_%: 
        $(MAKE) -C linux-$(LINUX_VER)-xen ARCH=xen INSTALL_NAME=$(subst linux_,$(LINUX_VER)-,$(@)) INSTALL_PATH=$(INSTALL_DIR) install
 
+# shorthand with no siffix
+linux: 
+       $(MAKE) -C linux-$(LINUX_VER)-xen ARCH=xen INSTALL_PATH=$(INSTALL_DIR) install  
 
+# build xen, the tools, and a domain 0 plus unprivileged linux-xen images,
+# and place them in the install directory. 'make install' should then
+# copy them to the normal system directories
 world: dist
        $(MAKE) linux-$(LINUX_VER)-xen
        $(MAKE) linux_xenU_config
        $(MAKE) linux_xenU
-       $(MAKE) linuc_xen0_config
+       $(MAKE) linux_xen0_config
        $(MAKE) linux_xen0
 
 
@@ -65,6 +75,7 @@ clean: delete-symlinks
        $(MAKE) -C xen clean
        $(MAKE) -C tools clean
 
+# clean, but blow away linux build tree plus src tar ball
 mrproper: clean
        rm -rf install linux-$(LINUX_VER)-xen linux-$(LINUX_VER).tar.gz